Методы взаимодействия с шаблонами отчётов
/services/reporting_module/api/reports/templates/remove
Метод удаления шаблона отчётов.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespace | string | пространство имён | нет | |
| alias | string | псевдоним | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/templates/get/page
Метод постраничной выборки описаний шаблонов отчётов
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| page | integer (int32) | номер страницы (начиная с 0) | да | |
| size | integer (int32) | максимальное число записей на странице | да | |
| sort | string | порядок сортировки записей (формат <поле сортировки>:<порядок сортировки>) | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/templates/get/by-namespace-alias
Метод выборки описания шаблона отчётов
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespace | string | пространство имён | нет | |
| alias | string | псевдоним | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/templates/download/template
Метод выгрузки файла шаблона библиотеки Jasper Reports.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespace | string | пространство имён | нет | |
| alias | string | псевдоним | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/templates/download/settings
Метод выгрузки файла настроек шаблона отчётов.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespace | string | пространство имён | нет | |
| alias | string | псевдоним | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в сл учае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/templates/download/settings-as-text
Метод выгрузки файла настроек шаблона отчётов в виде текста.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespace | string | пространство имён | нет | |
| alias | string | псевдоним | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/templates/add
Метод добавления/замены шаблона отчётов.
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| template | string (byte) | файл шаблона отчёта Jasper Reports | нет | |
| settings | string (byte) | файл настроек порядка формирования отчёта | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/templates/add/by-zip
Метод добавления шаблонов отчётов посредством архива в формате ZIP
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: multipart/form-data
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| templates | string (binary) | архив в формате ZIP | да |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |